home *** CD-ROM | disk | FTP | other *** search
/ Skunkware 5 / Skunkware 5.iso / man / cat.1 / sox.1 < prev    next >
Text File  |  1995-07-25  |  21KB  |  397 lines

  1.  
  2.  
  3.  
  4.      SSSSOOOOXXXX((((1111))))                   XXXXEEEENNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV                    SSSSOOOOXXXX((((1111))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           sox - SOund eXchange - universal sound sample translator
  10.  
  11.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.           ssssooooxxxx _i_n_f_i_l_e _o_u_t_f_i_l_e
  13.           ssssooooxxxx _i_n_f_i_l_e _o_u_t_f_i_l_e [[[[ _e_f_f_e_c_t [[[[ _e_f_f_e_c_t _o_p_t_i_o_n_s ... ]]]] ]]]]
  14.           ssssooooxxxx _i_n_f_i_l_e ----eeee _e_f_f_e_c_t [[[[ _e_f_f_e_c_t _o_p_t_i_o_n_s ... ]]]]
  15.           ssssooooxxxx [ _g_e_n_e_r_a_l _o_p_t_i_o_n_s  ]]]] [[[[ _f_o_r_m_a_t _o_p_t_i_o_n_s  ]]]] _i_f_i_l_e [[[[ _f_o_r_m_a_t
  16.           _o_p_t_i_o_n_s  ]]]] _o_f_i_l_e [[[[ _e_f_f_e_c_t [ _e_f_f_e_c_t _o_p_t_i_o_n_s ... ]]]] ]]]]
  17.           _G_e_n_e_r_a_l _o_p_t_i_o_n_s: [[[[ ----VVVV ]]]] [[[[ ----vvvv _v_o_l_u_m_e ]]]]
  18.           _F_o_r_m_a_t _o_p_t_i_o_n_s: [[[[ ----tttt _f_i_l_e_t_y_p_e ]]]] [[[[ ----rrrr _r_a_t_e ]]]] [[[[ ----ssss////----uuuu////----UUUU////----AAAA ]]]]
  19.           [[[[ ----bbbb////----wwww////----llll////----ffff////----dddd////----DDDD ]]]] [[[[ ----cccc _c_h_a_n_n_e_l_s ]]]] [[[[ ----xxxx ]]]]
  20.           _E_f_f_e_c_t_s:
  21.                ccccooooppppyyyy
  22.                rrrraaaatttteeee
  23.                aaaavvvvgggg
  24.                ssssttttaaaatttt
  25.                eeeecccchhhhoooo _d_e_l_a_y _v_o_l_u_m_e [[[[ _d_e_l_a_y _v_o_l_u_m_e ... ]]]]
  26.                vvvviiiibbbbrrrroooo _s_p_e_e_d [[[[ _d_e_p_t_h ]]]]
  27.                lllloooowwwwpppp _c_e_n_t_e_r
  28.                bbbbaaaannnndddd [[[[ -_n ]]]] _c_e_n_t_e_r [[[[ _w_i_d_t_h ]]]]
  29.  
  30.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  31.           _S_o_x translates sound files from one format to another,
  32.           possibly doing a sound effect.
  33.  
  34.      OOOOPPPPTTTTIIIIOOOONNNNSSSS
  35.           The option syntax is a little grotty, but in essence:
  36.                sox file.au file.voc
  37.           translates a sound sample in SUN Sparc .AU format into a
  38.           SoundBlaster .VOC file, while
  39.                sox -v 0.5 file.au -rate 12000 file.voc rate
  40.           does the same format translation but also lowers the
  41.           amplitude by 1/2 and changes the sampling rate from 8000
  42.           hertz to 12000 hertz via the rrrraaaatttteeee _s_o_u_n_d _e_f_f_e_c_t loop.
  43.  
  44.           File type options:
  45.  
  46.           ----tttt _f_i_l_e_t_y_p_e
  47.                     gives the type of the sound sample file.
  48.  
  49.           ----rrrr _r_a_t_e   Give sample rate in Hertz of file.
  50.  
  51.           ----ssss////----uuuu////----UUUU////----AAAA
  52.                     The sample data is signed linear (2's complement),
  53.                     unsigned linear, U-law (logarithmic), or A-law
  54.                     (logarithmic).  U-law and A-law are the U.S. and
  55.                     international standards for logarithmic telephone
  56.                     sound compression.
  57.  
  58.           ----bbbb////----wwww////----llll////----ffff////----dddd////----DDDD
  59.                     The sample data is in bytes, 16-bit words, 32-bit
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 7/27/94)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      SSSSOOOOXXXX((((1111))))                   XXXXEEEENNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV                    SSSSOOOOXXXX((((1111))))
  71.  
  72.  
  73.  
  74.                     longwords, 32-bit floats, 64-bit double floats, or
  75.                     80-bit IEEE floats.  Floats and double floats are
  76.                     in native machine format.
  77.  
  78.           ----xxxx        The sample data is in XINU format; that is, it
  79.                     comes from a machine with the opposite word order
  80.                     than yours and must be swapped according to the
  81.                     word-size given above.  Only 16-bit and 32-bit
  82.                     integer data may be swapped.  Machine-format
  83.                     floating-point data is not portable.  IEEE floats
  84.                     are a fixed, portable format. ???
  85.  
  86.           ----cccc _c_h_a_n_n_e_l_s
  87.                     The number of sound channels in the data file.
  88.                     This may be 1, 2, or 4; for mono, stereo, or quad
  89.                     sound data.
  90.  
  91.           General options:
  92.  
  93.           ----eeee        after the input file allows you to avoid giving an
  94.                     output file and just name an effect.  This is only
  95.                     useful with the ssssttttaaaatttt effect.
  96.  
  97.           ----vvvv _v_o_l_u_m_e Change amplitude (floating point); less than 1.0
  98.                     decreases, greater than 1.0 increases.  Note: we
  99.                     perceive volume logarithmically, not linearly.
  100.                     Note: see the ssssttttaaaatttt effect.
  101.  
  102.           ----VVVV        Print a description of processing phases.  Useful
  103.                     for figuring out exactly how _s_o_x is mangling your
  104.                     sound samples.
  105.  
  106.           The input and output files may be standard input and output.
  107.           This is specified by '-'.  The ----tttt _t_y_p_e option must be given
  108.           in this case, else _s_o_x will not know the format of the given
  109.           file.  The ----tttt,,,, ----rrrr,,,, ----ssss////----uuuu////----UUUU////----AAAA,,,, ----bbbb////----wwww////----llll////----ffff////----dddd////----DDDD and ----xxxx
  110.           options refer to the input data when given before the input
  111.           file name.  After, they refer to the output data.
  112.  
  113.           If you don't give an output file name, _s_o_x will just read
  114.           the input file.  This is useful for validating structured
  115.           file formats; the ssssttttaaaatttt effect may also be used via the ----eeee
  116.           option.
  117.  
  118.      FFFFIIIILLLLEEEE TTTTYYYYPPPPEEEESSSS
  119.           _S_o_x needs to know the formats of the input and output files.
  120.           File formats which have headers are checked, if that header
  121.           doesn't seem right, the program exits with an appropriate
  122.           message.  Currently, the raw (no header), IRCAM Sound Files,
  123.           Sound Blaster, SPARC .AU (w/header), Mac HCOM, PC/DOS .SOU,
  124.           Sndtool, and Sounder, NeXT .SND, Windows 3.1 RIFF/WAV,
  125.           Turtle Beach .SMP, and Apple/SGI AIFF and 8SVX formats are
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 7/27/94)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      SSSSOOOOXXXX((((1111))))                   XXXXEEEENNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV                    SSSSOOOOXXXX((((1111))))
  137.  
  138.  
  139.  
  140.           supported.
  141.  
  142.           ....aaaaiiiiffffffff     AIFF files used on Apple IIc/IIgs and SGI.  Note:
  143.                     the AIFF format supports only one SSND chunk.  It
  144.                     does not support multiple sound chunks, or the
  145.                     8SVX musical instrument description format.  AIFF
  146.                     files are multimedia archives and and can have
  147.                     multiple audio and picture chunks.  You may need a
  148.                     separate archiver to work with them.
  149.  
  150.           ....aaaauuuu       SUN Microsystems AU files.  There are apparently
  151.                     many types of .au files; DEC has invented its own
  152.                     with a different magic number and word order. The
  153.                     .au handler can read these files but will not
  154.                     write them.  Some .au files have valid AU headers
  155.                     and some do not.  The latter are probably original
  156.                     SUN u-law 8000 hz samples.  These can be dealt
  157.                     with using the ....uuuullll format (see below).
  158.  
  159.           ....hhhhccccoooommmm     Macintosh HCOM files.  These are (apparently) Mac
  160.                     FSSD files with some variant of Huffman
  161.                     compression.  The Macintosh has wacky file formats
  162.                     and this format handler apparently doesn't handle
  163.                     all the ones it should.  Mac users will need your
  164.                     usual arsenal of file converters to deal with an
  165.                     HCOM file under Unix or DOS.
  166.  
  167.           ....rrrraaaawwww      Raw files (no header).
  168.                     The sample rate, size (byte, word, etc), and style
  169.                     (signed, unsigned, etc.) of the sample file must
  170.                     be given.  The number of channels defaults to 1.
  171.  
  172.           ....uuuubbbb,,,, ....ssssbbbb,,,, ....uuuuwwww,,,, ....sssswwww,,,, ....uuuullll
  173.                     These are several suffices which serve as a
  174.                     shorthand for raw files with a given size and
  175.                     style.  Thus, uuuubbbb,,,, ssssbbbb,,,, uuuuwwww,,,, sssswwww,,,, and uuuullll correspond to
  176.                     "unsigned byte", "signed byte", "unsigned word",
  177.                     "signed word", and "ulaw" (byte).  The sample rate
  178.                     defaults to 8000 hz if not explicitly set, and the
  179.                     number of channels (as always) defaults to 1.
  180.                     There are lots of Sparc samples floating around in
  181.                     u-law format with no header and fixed at a sample
  182.                     rate of 8000 hz.  (Certain sound management
  183.                     software cheerfully ignores the headers.)
  184.                     Similarly, most Mac sound files are in unsigned
  185.                     byte format with a sample rate of 11025 or 22050
  186.                     hz.
  187.  
  188.           ....ssssffff       IRCAM Sound Files.
  189.                     SoundFiles are used by academic music software
  190.                     such as the CSound package, and the MixView sound
  191.                     sample editor.
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 7/27/94)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      SSSSOOOOXXXX((((1111))))                   XXXXEEEENNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV                    SSSSOOOOXXXX((((1111))))
  203.  
  204.  
  205.  
  206.           ....vvvvoooocccc      Sound Blaster VOC files.
  207.                     VOC files are multi-part and contain silence
  208.                     parts, looping, and different sample rates for
  209.                     different chunks.  On input, the silence parts are
  210.                     filled out, loops are rejected, and sample data
  211.                     with a new sample rate is rejected.  Silence with
  212.                     a different sample rate is generated
  213.                     appropriately.  On output, silence is not
  214.                     detected, nor are impossible sample rates.
  215.  
  216.           ....aaaauuuuttttoooo     This is a ``meta-type'': specifying this type for
  217.                     an input file triggers some code that tries to
  218.                     guess the real type by looking for magic words in
  219.                     the header.  If the type can't be guessed, the
  220.                     program exits with an error message.  The input
  221.                     must be a plain file, not a pipe.  This type can't
  222.                     be used for output files.
  223.  
  224.           ....ssssmmmmpppp      Turtle Beach SampleVision files.
  225.                     SMP files are for use with the PC-DOS package
  226.                     SampleVision by Turtle Beach Softworks. This
  227.                     package is for communication to several MIDI
  228.                     samplers. All sample rates are supported by the
  229.                     package, although not all are supported by the
  230.                     samplers themselves. Currently loop points are
  231.                     ignored.
  232.  
  233.           ....wwwwaaaavvvv      Windows 3.1 .WAV RIFF files.
  234.                     These appear to be very similar to IFF files, but
  235.                     not the same. They are the native sound file
  236.                     format of Windows 3.1.  Obviously, Windows 3.1 is
  237.                     of such incredible importance to the computer
  238.                     industry that it just had to have its own sound
  239.                     file format.
  240.  
  241.      EEEEFFFFFFFFEEEECCCCTTTTSSSS
  242.           Only one effect from the palette may be applied to a sound
  243.           sample.  To do multiple effects you'll need to run _s_o_x in a
  244.           pipeline.
  245.  
  246.           copy                          Copy the input file to the
  247.                                         output file.  This is the
  248.                                         default effect if both files
  249.                                         have the same sampling rate,
  250.                                         or the rates are "close".
  251.  
  252.           rate                          Translate input sampling rate
  253.                                         to output sampling rate via
  254.                                         linear interpolation to the
  255.                                         Least Common Multiple of the
  256.                                         two sampling rates.  This is
  257.                                         the default effect if the two
  258.  
  259.  
  260.  
  261.      Page 4                                          (printed 7/27/94)
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.      SSSSOOOOXXXX((((1111))))                   XXXXEEEENNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV                    SSSSOOOOXXXX((((1111))))
  269.  
  270.  
  271.  
  272.                                         files have different sampling
  273.                                         rates.  This is fast but
  274.                                         noisy.
  275.  
  276.           avg                           Mix 4- or 2-channel sound file
  277.                                         into 2- or 1-channel file by
  278.                                         averaging the samples for
  279.                                         different speakers.
  280.  
  281.           stat                          Do a statistical check on the
  282.                                         input file, and print results
  283.                                         on the standard error file.
  284.                                         ssssttttaaaatttt may copy the file
  285.                                         untouched from input to
  286.                                         output, if you select an
  287.                                         output file. The "Volume
  288.                                         Adjustment:" field in the
  289.                                         statistics gives you the
  290.                                         argument to the ----vvvv _n_u_m_b_e_r
  291.                                         which will make the sample as
  292.                                         loud as possible.
  293.  
  294.           echo [ _d_e_l_a_y _v_o_l_u_m_e ...  ]]]]    Add echoing to a sound sample.
  295.                                         Each delay/volume pair gives
  296.                                         the delay in seconds and the
  297.                                         volume (relative to 1.0) of
  298.                                         that echo.  If the volumes add
  299.                                         up to more than 1.0, the sound
  300.                                         will melt down instead of
  301.                                         fading away.
  302.  
  303.           vibro _s_p_e_e_d  [[[[ _d_e_p_t_h ]]]]        Add the world-famous Fender
  304.                                         Vibro-Champ sound effect to a
  305.                                         sound sample by using a sine
  306.                                         wave as the volume knob.
  307.                                         SSSSppppeeeeeeeedddd gives the Hertz value of
  308.                                         the wave.  This must be under
  309.                                         30.  DDDDeeeepppptttthhhh gives the amount
  310.                                         the volume is cut into by the
  311.                                         sine wave, ranging 0.0 to 1.0
  312.                                         and defaulting to 0.5.
  313.  
  314.           lowp _c_e_n_t_e_r                   Apply a low-pass filter.  The
  315.                                         frequency response drops
  316.                                         logarithmically with _c_e_n_t_e_r
  317.                                         frequency in the middle of the
  318.                                         drop.  The slope of the filter
  319.                                         is quite gentle.
  320.  
  321.           band [[[[ -_n ]]]] _c_e_n_t_e_r [[[[ _w_i_d_t_h ]]]]  Apply a band-pass filter.  The
  322.                                         frequency response drops
  323.                                         logarithmically around the
  324.  
  325.  
  326.  
  327.      Page 5                                          (printed 7/27/94)
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.      SSSSOOOOXXXX((((1111))))                   XXXXEEEENNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV                    SSSSOOOOXXXX((((1111))))
  335.  
  336.  
  337.  
  338.                                         _c_e_n_t_e_r frequency.  The _w_i_d_t_h
  339.                                         gives the slope of the drop.
  340.                                         The frequencies at _c_e_n_t_e_r +
  341.                                         _w_i_d_t_h and _c_e_n_t_e_r - _w_i_d_t_h will
  342.                                         be half of their original
  343.                                         amplitudes.  BBBBaaaannnndddd defaults to
  344.                                         a mode oriented to pitched
  345.                                         signals, i.e. voice, singing,
  346.                                         or instrumental music.  The -_n
  347.                                         (for noise) option uses the
  348.                                         alternate mode for un-pitched
  349.                                         signals.  BBBBaaaannnndddd introduces
  350.                                         noise in the shape of the
  351.                                         filter, i.e. peaking at the
  352.                                         _c_e_n_t_e_r frequency and settling
  353.                                         around it.
  354.  
  355.           _S_o_x enforces certain effects.  If the two files have
  356.           different sampling rates, the requested effect must be one
  357.           of ccccooooppppyyyy,,,, or rrrraaaatttteeee,,,, If the two files have different numbers of
  358.           channels, the aaaavvvvgggg effect must be requested.
  359.  
  360.      BBBBUUUUGGGGSSSS
  361.           The syntax is horrific.  It's very tempting to include a
  362.           default system that allows an effect name as the program
  363.           name and just pipes a sound sample from standard input to
  364.           standard output, but the problem of inputting the sample
  365.           rates makes this unworkable.
  366.  
  367.      FFFFIIIILLLLEEEESSSS
  368.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  369.      NNNNOOOOTTTTIIIICCCCEEEESSSS
  370.           The echoplex effect is:
  371.               Copyright (C) 1989 by Jef Poskanzer.
  372.               Permission to use, copy, modify, and distribute this
  373.           software and its
  374.               documentation for any purpose and without fee is hereby
  375.           granted, provided
  376.               that the above copyright notice appear in all copies and
  377.           that both that
  378.               copyright notice and this permission notice appear in
  379.           supporting
  380.               documentation.  This software is provided "as is"
  381.           without express or
  382.               implied warranty.
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.      Page 6                                          (printed 7/27/94)
  394.  
  395.  
  396.  
  397.